add engine_preparePayload_debug endpoint by garyschulte · Pull Request #4427 · hyperledger/besu

garyschulte · 2022-09-22T21:34:42Z

PR description

PR to enable debugging block proposals by re-adding an updated version of the deprecated
engine_preparePayload endpoint

be sure to use the current or a recent parent blockhash or you will DoS bonsai db

All fields in the parameter are optional, including the parameter itself

example usage:

curl --location --request POST 'http://localhost:8551' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2NTkwNDEzMzZ9.4PDdSaG9hFOFR4Th7rEgaKKECsXfz6IPckFRcfSP13o' \
--data-raw '{
    "jsonrpc":"2.0",
    "method":"engine_preparePayload_debug",
    "params":
    [
        {
            "parentHash": "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
            "feeRecipient": "0x0000000000000000000000000000000000000000",
            "timestamp": "0x0",
            "prevRandao": "0x0",
            "withdrawals": []
        }
    ],
    "id":1
}'

OR, this usage will use fee recipient 0x00..00, current timestamp, current chain head, "deadbeef" prevrandao, and empty withdrawals:

curl --location --request POST 'http://localhost:8551' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2NTkwNDEzMzZ9.4PDdSaG9hFOFR4Th7rEgaKKECsXfz6IPckFRcfSP13o' \
--data-raw '{
    "jsonrpc":"2.0",
    "method":"engine_preparePayload_debug",
    "params":
    [],
    "id":1
}'

Fixed Issue(s)

Documentation

I thought about documentation and added the doc-change-required label to this PR if
updates are required.

Changelog

I thought about the changelog and included a changelog update if required.

jflo · 2022-09-27T14:44:31Z

Since this is a debug method, would it be simpler to use if it always built on the chainhead? It would be less timing/juggling when it is being used.

garyschulte · 2022-10-05T20:05:07Z

Since this is a debug method, would it be simpler to use if it always built on the chainhead? It would be less timing/juggling when it is being used.

yes, yes it would 👍 . I think we can do the same thing we do with timestamp and default it to the current head if it is otherwise not specified

gfukushima · 2023-01-20T09:45:01Z

Hi Gary, can this be closed since it's been merged as part of another PR?

garyschulte · 2023-02-23T19:07:46Z

Hi Gary, can this be closed since it's been merged as part of another PR?

this was merged in a speculative RC candidate, and isn't in main yet.

non-fungible-nelson · 2023-04-13T19:01:25Z

can we close or re-status this @garyschulte ?

garyschulte · 2023-04-13T19:04:11Z

IMO we should rebase and merge as it is useful for debugging proposals. @fab-10 was using a different mechanism to test proposals IIRC, so would be helpful to get his opinion

fab-10 · 2023-04-18T12:08:08Z

IMO we should rebase and merge as it is useful for debugging proposals. @fab-10 was using a different mechanism to test proposals IIRC, so would be helpful to get his opinion

It make sense to have this endpoint as well, it is an easier and fast method to trigger a payload creation

...hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EnginePreparePayloadDebug.java

...hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/EnginePreparePayloadParameter.java

gfukushima · 2023-04-19T03:42:10Z

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/RpcMethod.java

  ENGINE_GET_PAYLOAD_BODIES_BY_RANGE_V1("engine_getPayloadBodiesByRangeV1"),
  ENGINE_EXCHANGE_CAPABILITIES("engine_exchangeCapabilities"),
-
+  ENGINE_PREPARE_PAYLOAD_DEBUG("engine_preparePayload_debug"),


Here is a tricky question, shouldn't this method be in the debug set? Another reason to move that is, the way we built the engine_exchange_capabilities mean Besu might report this method. CL is probably going to ignore it though.

DEBUG is present even if the ENGINE api is not, so I think this needs to live within engine api. Good point about the capabilities though 🤔 I will check to see if this causes problems for CLs

What about a ENGINE_DEBUG set? So it is separated from ENGINE and can be enabled only if used

I filtered the debug prepare payload from the capabilities list in the same way the capabilities list filters itself 👍

just saw the ENGINE_DEBUG set suggestion. I think we could add something like that if we have more than one engine debug endpoint in the future 👍 . Rule of three applies in this case IMO

...hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EnginePreparePayloadDebug.java

Signed-off-by: garyschulte <garyschulte@gmail.com>

…, unit test coverage Signed-off-by: garyschulte <garyschulte@gmail.com>

Signed-off-by: garyschulte <garyschulte@gmail.com>

implemented suggested changes

macfarla

LGTM

Signed-off-by: garyschulte <garyschulte@gmail.com>

garyschulte force-pushed the feature/debug_preparePayload branch from 5daa0ad to d2a46f4 Compare September 22, 2022 21:41

garyschulte force-pushed the feature/debug_preparePayload branch from a08359a to 097264e Compare October 5, 2022 22:33

garyschulte force-pushed the feature/debug_preparePayload branch from 0cb6ee6 to 097e121 Compare October 28, 2022 23:40

garyschulte mentioned this pull request Nov 2, 2022

merge Parallelize calculate root hash into RC3 #4590

Merged

2 tasks

garyschulte force-pushed the feature/debug_preparePayload branch from 097e121 to 35c9fb9 Compare February 23, 2023 19:05

garyschulte marked this pull request as ready for review February 23, 2023 19:07

garyschulte force-pushed the feature/debug_preparePayload branch from bd81e68 to 0166200 Compare February 23, 2023 19:20

fab-10 previously requested changes Apr 18, 2023

View reviewed changes

...hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EnginePreparePayloadDebug.java Outdated Show resolved Hide resolved

...hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/EnginePreparePayloadParameter.java Outdated Show resolved Hide resolved

garyschulte force-pushed the feature/debug_preparePayload branch from 0166200 to 154f2fb Compare April 19, 2023 03:15

garyschulte enabled auto-merge (squash) April 19, 2023 03:16

gfukushima reviewed Apr 19, 2023

View reviewed changes

macfarla reviewed Apr 19, 2023

View reviewed changes

...hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EnginePreparePayloadDebug.java Outdated Show resolved Hide resolved

garyschulte added 3 commits April 19, 2023 09:06

rebase on origin/main

a32bcff

Signed-off-by: garyschulte <garyschulte@gmail.com>

address feedback, add withdrawals

b5d8351

Signed-off-by: garyschulte <garyschulte@gmail.com>

filter debug payload from engine capabilities, add a syncing response…

c845900

…, unit test coverage Signed-off-by: garyschulte <garyschulte@gmail.com>

garyschulte force-pushed the feature/debug_preparePayload branch from 154f2fb to c845900 Compare April 19, 2023 17:27

garyschulte disabled auto-merge April 19, 2023 17:41

garyschulte added 2 commits April 19, 2023 10:42

make any/all parameters optional for debug payload

12314e4

Signed-off-by: garyschulte <garyschulte@gmail.com>

spdx header

01f73e9

Signed-off-by: garyschulte <garyschulte@gmail.com>

garyschulte enabled auto-merge (squash) April 19, 2023 18:02

macfarla approved these changes Apr 19, 2023

View reviewed changes

garyschulte merged commit de4aa7b into hyperledger:main Apr 19, 2023

garyschulte deleted the feature/debug_preparePayload branch April 20, 2023 00:30

michaelsproul mentioned this pull request Aug 9, 2023

Full payload building sigp/eleel#12

Open

elenduuche pushed a commit to elenduuche/besu that referenced this pull request Aug 16, 2023

add engine_preparePayload_debug endpoint (hyperledger#4427)

5444e0b

Signed-off-by: garyschulte <garyschulte@gmail.com>

eum602 pushed a commit to lacchain/besu that referenced this pull request Nov 3, 2023

add engine_preparePayload_debug endpoint (hyperledger#4427)

da43b8d

Signed-off-by: garyschulte <garyschulte@gmail.com>

siladu mentioned this pull request Dec 6, 2025

Add RPC endpoint testing_buildBlockV1 ethereum/execution-apis#710

Draft

Conversation

garyschulte commented Sep 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR description

Fixed Issue(s)

Documentation

Changelog

Uh oh!

jflo commented Sep 27, 2022

Uh oh!

garyschulte commented Oct 5, 2022

Uh oh!

gfukushima commented Jan 20, 2023

Uh oh!

garyschulte commented Feb 23, 2023

Uh oh!

non-fungible-nelson commented Apr 13, 2023

Uh oh!

garyschulte commented Apr 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fab-10 commented Apr 18, 2023

Uh oh!

Uh oh!

Uh oh!

gfukushima Apr 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

garyschulte Apr 19, 2023

Choose a reason for hiding this comment

Uh oh!

fab-10 Apr 19, 2023

Choose a reason for hiding this comment

Uh oh!

garyschulte Apr 19, 2023

Choose a reason for hiding this comment

Uh oh!

garyschulte Apr 19, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

macfarla left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

garyschulte commented Sep 22, 2022 •

edited

Loading

garyschulte commented Apr 13, 2023 •

edited

Loading

gfukushima Apr 19, 2023 •

edited

Loading